<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>query FRS API to find EPA facilities by registry ID or program ID — locate_by_id • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="query FRS API to find EPA facilities by registry ID or program ID — locate_by_id"><meta name="description" content="Uses the Facility Registry Service (FRS) API to find sites by ID.
This uses an API to find sites, but it is faster to look in a table
if that FRS dataset is already loaded in an app, for example."><meta property="og:description" content="Uses the Facility Registry Service (FRS) API to find sites by ID.
This uses an API to find sites, but it is faster to look in a table
if that FRS dataset is already loaded in an app, for example."><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>query FRS API to find EPA facilities by registry ID or program ID</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/utils_locate_by_id.R" class="external-link"><code>R/utils_locate_by_id.R</code></a></small>
      <div class="d-none name"><code>locate_by_id.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Uses the Facility Registry Service (FRS) API to find sites by ID.
This uses an API to find sites, but it is faster to look in a table
if that FRS dataset is already loaded in an app, for example.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">locate_by_id</span><span class="op">(</span><span class="va">id</span>, type <span class="op">=</span> <span class="st">"frs"</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-id">id<a class="anchor" aria-label="anchor" href="#arg-id"></a></dt>
<dd><p>vector of one or more character strings that must be
registry IDs (default) or program IDs</p></dd>


<dt id="arg-type">type<a class="anchor" aria-label="anchor" href="#arg-type"></a></dt>
<dd><p>either frs (default) or program.
frs means all are registry_id and
program means all are pgm_sys_id</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>passed through to <code><a href="locate_by_id1.html">locate_by_id1()</a></code></p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>data.frame with one row per queried id, columns as returned by API
but lat lon instead of Latitude83 Longitude83</p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="locate_by_id1.html">locate_by_id1()</a></code> and alias is <code>get_facility_info_via_FRS()</code></p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span>  <span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span>    </span>
<span>  <span class="va">ids</span> <span class="op">&lt;-</span> <span class="va">testids_program_sys_id</span></span>
<span>  <span class="co"># ids &lt;- c('ILR000128264','600039382','TXR1592DZ','TSCA8851', </span></span>
<span>  <span class="co">#    'CT0000000900908716', 'CEDRI10043548',  'CO0000000812305826')</span></span>
<span>  <span class="co"># ids &lt;- c('ILR000128264','600039382')</span></span>
<span>  <span class="fu">locate_by_id</span><span class="op">(</span><span class="va">ids</span>, type <span class="op">=</span> <span class="st">'program'</span><span class="op">)</span>   <span class="co"># stopped working   ***********</span></span>
<span>   </span>
<span> <span class="va">sites_found_by_registry_id</span> <span class="op">&lt;-</span> <span class="fu">locate_by_id</span><span class="op">(</span><span class="va">testids_registry_id</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span>,    </span>
<span>   type<span class="op">=</span><span class="st">'frs'</span><span class="op">)</span></span>
<span> <span class="va">sites_found_by_program_id</span>  <span class="op">&lt;-</span> <span class="fu">locate_by_id</span><span class="op">(</span><span class="va">testids_program_sys_id</span><span class="op">[</span><span class="fl">1</span><span class="op">]</span>, </span>
<span>   type<span class="op">=</span><span class="st">'program'</span><span class="op">)</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span><span class="va">example_REGID</span>  <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="va">sites_found_by_registry_id</span><span class="op">)</span><span class="op">)</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span><span class="va">example_PGMID</span>  <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="va">sites_found_by_program_id</span><span class="op">)</span><span class="op">)</span></span>
<span> <span class="co"># Finding several facilities is slow:</span></span>
<span> <span class="va">sites_found_by_registry_id</span> <span class="op">&lt;-</span> <span class="fu">locate_by_id</span><span class="op">(</span><span class="va">testids_registry_id</span>,    </span>
<span>   type<span class="op">=</span><span class="st">'frs'</span><span class="op">)</span></span>
<span> <span class="va">sites_found_by_program_id</span>  <span class="op">&lt;-</span> <span class="fu">locate_by_id</span><span class="op">(</span><span class="va">testids_program_sys_id</span>, </span>
<span>   type<span class="op">=</span><span class="st">'program'</span><span class="op">)</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">sites_found_by_program_id</span><span class="op">)</span> </span>
<span> <span class="va">sites_found_by_registry_id</span><span class="op">[</span>,<span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'RegistryId'</span>, <span class="st">'lon'</span>,<span class="st">'lat'</span><span class="op">)</span><span class="op">]</span></span>
<span> <span class="co">## and  just to show agreement:  </span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span></span>
<span>  <span class="va">testids_program_sys_id</span>,</span>
<span>  frs <span class="op">=</span>  <span class="va">frs</span><span class="op">[</span><span class="fu"><a href="https://rdrr.io/r/base/match.html" class="external-link">match</a></span><span class="op">(</span></span>
<span>    <span class="va">sites_found_by_program_id</span><span class="op">$</span><span class="va">RegistryId</span>, </span>
<span>     <span class="va">frs</span><span class="op">$</span><span class="va">REGISTRY_ID</span></span>
<span>    <span class="op">)</span>, </span>
<span>    <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'PGM_SYS_ACRNMS'</span>,  <span class="st">'REGISTRY_ID'</span><span class="op">)</span><span class="op">]</span>,</span>
<span>  api <span class="op">=</span> <span class="va">sites_found_by_program_id</span><span class="op">[</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'RegistryId'</span>, <span class="st">'lat'</span>, <span class="st">'lon'</span><span class="op">)</span><span class="op">]</span> </span>
<span> <span class="op">)</span></span>
<span> </span>
<span> <span class="co"># Leaflet map of sites, with a popup when one clicks on a site</span></span>
<span> <span class="va">df</span> <span class="op">&lt;-</span> <span class="va">sites_found_by_registry_id</span></span>
<span> <span class="va">others</span> <span class="op">&lt;-</span>  <span class="va">frs</span><span class="op">[</span><span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fu"><a href="https://rdrr.io/r/base/nrow.html" class="external-link">NROW</a></span><span class="op">(</span> <span class="va">frs</span><span class="op">)</span>, <span class="fl">5000</span><span class="op">)</span>, </span>
<span>  <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'lon'</span>, <span class="st">'lat'</span><span class="op">)</span><span class="op">]</span></span>
<span>   <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/leaflet.html" class="external-link">leaflet</a></span><span class="op">(</span><span class="va">df</span><span class="op">[</span><span class="fl">4</span><span class="op">:</span><span class="fl">6</span>,<span class="op">]</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/map-layers.html" class="external-link">addTiles</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span>     <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/map-layers.html" class="external-link">addMarkers</a></span><span class="op">(</span>popup <span class="op">=</span> <span class="fu"><a href="popup_from_df.html">popup_from_df</a></span><span class="op">(</span><span class="va">df</span><span class="op">[</span><span class="fl">4</span><span class="op">:</span><span class="fl">6</span>,<span class="op">]</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span>     <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/map-layers.html" class="external-link">addCircles</a></span><span class="op">(</span>lng <span class="op">=</span> <span class="va">others</span><span class="op">$</span><span class="va">lon</span>, lat<span class="op">=</span><span class="va">others</span><span class="op">$</span><span class="va">lat</span>, </span>
<span>       radius <span class="op">=</span> <span class="fl">3</span><span class="op">*</span><span class="va">meters_per_mile</span>, color <span class="op">=</span> <span class="st">'gray'</span><span class="op">)</span></span>
<span>      </span>
<span><span class="co"># Map with clickable icons   </span></span>
<span><span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/leaflet.html" class="external-link">leaflet</a></span><span class="op">(</span><span class="va">df</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/map-layers.html" class="external-link">addTiles</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<span><span class="co"># leaflet::addCircleMarkers(lng=~lon, lat=~lat, radius = 3) |&gt;</span></span>
<span> <span class="fu">leaflet</span><span class="fu">::</span><span class="fu"><a href="https://rstudio.github.io/leaflet/reference/map-layers.html" class="external-link">addMarkers</a></span><span class="op">(</span>popup <span class="op">=</span> <span class="fu"><a href="popup_from_df.html">popup_from_df</a></span><span class="op">(</span><span class="va">df</span><span class="op">)</span>, </span>
<span> icon <span class="op">=</span> <span class="fu">icons</span><span class="op">(</span>iconUrl <span class="op">=</span> <span class="st">'./www/factory1.svg'</span>, </span>
<span>   iconWidth <span class="op">=</span> <span class="fl">30</span>, iconAnchorX <span class="op">=</span> <span class="fl">14</span>, iconAnchorY <span class="op">=</span> <span class="fl">18</span><span class="op">)</span></span>
<span> <span class="op">)</span></span>
<span>  <span class="co"># Simple map of sites queried (among a sample of US EPA-regulated sites):</span></span>
<span>    </span>
<span> <span class="va">xl</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="op">-</span><span class="fl">125</span>,<span class="op">-</span><span class="fl">66</span><span class="op">)</span>; <span class="va">yl</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">17</span>,<span class="fl">50</span><span class="op">)</span> <span class="co"># just continental US plus PR </span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span> <span class="va">frs</span><span class="op">[</span><span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fl">1</span><span class="op">:</span><span class="fu"><a href="https://rdrr.io/r/base/nrow.html" class="external-link">NROW</a></span><span class="op">(</span>  <span class="va">frs</span><span class="op">)</span>,<span class="fl">5000</span><span class="op">)</span>,<span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">'lon'</span>,<span class="st">'lat'</span><span class="op">)</span><span class="op">]</span>,</span>
<span>  xlim<span class="op">=</span><span class="va">xl</span>, ylim<span class="op">=</span><span class="va">yl</span>, col<span class="op">=</span><span class="st">'gray'</span><span class="op">)</span></span>
<span> <span class="fu">graphics</span><span class="fu">::</span><span class="fu"><a href="https://rdrr.io/r/graphics/points.html" class="external-link">points</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/cbind.html" class="external-link">cbind</a></span><span class="op">(</span></span>
<span>  LONG<span class="op">=</span><span class="va">sites_found_by_program_id</span><span class="op">$</span><span class="va">lon</span>, </span>
<span>  LAT<span class="op">=</span><span class="va">sites_found_by_program_id</span><span class="op">$</span><span class="va">lat</span><span class="op">)</span>, </span>
<span>  col<span class="op">=</span><span class="st">'red'</span>, pch<span class="op">=</span><span class="fl">16</span><span class="op">)</span></span>
<span> <span class="op">}</span> <span class="co"># }</span></span>
<span> </span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

